<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>@vertx/web</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="index.html" class="title">@vertx/web</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="globals.html">Globals</a>
				</li>
			</ul>
			<h1> @vertx/web</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Enumerations</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-enum"><a href="enums/loggerformat.html" class="tsd-kind-icon">Logger<wbr>Format</a></li>
								<li class="tsd-kind-enum"><a href="enums/transport.html" class="tsd-kind-icon">Transport</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Classes</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-class"><a href="classes/basicauthhandler.html" class="tsd-kind-icon">Basic<wbr>Auth<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/bodyhandler.html" class="tsd-kind-icon">Body<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/bridgeevent.html" class="tsd-kind-icon">Bridge<wbr>Event</a></li>
								<li class="tsd-kind-class"><a href="classes/bridgeoptions.html" class="tsd-kind-icon">Bridge<wbr>Options</a></li>
								<li class="tsd-kind-class"><a href="classes/csrfhandler.html" class="tsd-kind-icon">CSRFHandler</a></li>
								<li class="tsd-kind-class"><a href="classes/chainauthhandler.html" class="tsd-kind-icon">Chain<wbr>Auth<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/clusteredsessionstore.html" class="tsd-kind-icon">Clustered<wbr>Session<wbr>Store</a></li>
								<li class="tsd-kind-class"><a href="classes/cookie.html" class="tsd-kind-icon">Cookie</a></li>
								<li class="tsd-kind-class"><a href="classes/cookiehandler.html" class="tsd-kind-icon">Cookie<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/corshandler.html" class="tsd-kind-icon">Cors<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/digestauthhandler.html" class="tsd-kind-icon">Digest<wbr>Auth<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/errorhandler.html" class="tsd-kind-icon">Error<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/faviconhandler.html" class="tsd-kind-icon">Favicon<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/fileupload.html" class="tsd-kind-icon">File<wbr>Upload</a></li>
								<li class="tsd-kind-class"><a href="classes/formloginhandler.html" class="tsd-kind-icon">Form<wbr>Login<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/http2pushmapping.html" class="tsd-kind-icon">Http2<wbr>Push<wbr>Mapping</a></li>
								<li class="tsd-kind-class"><a href="classes/jwtauthhandler.html" class="tsd-kind-icon">JWTAuth<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/languageheader.html" class="tsd-kind-icon">Language<wbr>Header</a></li>
								<li class="tsd-kind-class"><a href="classes/localsessionstore.html" class="tsd-kind-icon">Local<wbr>Session<wbr>Store</a></li>
								<li class="tsd-kind-class"><a href="classes/locale.html" class="tsd-kind-icon">Locale</a></li>
								<li class="tsd-kind-class"><a href="classes/loggerhandler.html" class="tsd-kind-icon">Logger<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/mimeheader.html" class="tsd-kind-icon">MIMEHeader</a></li>
								<li class="tsd-kind-class"><a href="classes/oauth2authhandler.html" class="tsd-kind-icon">OAuth2<wbr>Auth<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/parsedheadervalue.html" class="tsd-kind-icon">Parsed<wbr>Header<wbr>Value</a></li>
								<li class="tsd-kind-class"><a href="classes/parsedheadervalues.html" class="tsd-kind-icon">Parsed<wbr>Header<wbr>Values</a></li>
								<li class="tsd-kind-class"><a href="classes/permittedoptions.html" class="tsd-kind-icon">Permitted<wbr>Options</a></li>
								<li class="tsd-kind-class"><a href="classes/redirectauthhandler.html" class="tsd-kind-icon">Redirect<wbr>Auth<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/responsecontenttypehandler.html" class="tsd-kind-icon">Response<wbr>Content<wbr>Type<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/responsetimehandler.html" class="tsd-kind-icon">Response<wbr>Time<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/route.html" class="tsd-kind-icon">Route</a></li>
								<li class="tsd-kind-class"><a href="classes/router.html" class="tsd-kind-icon">Router</a></li>
								<li class="tsd-kind-class"><a href="classes/routingcontext.html" class="tsd-kind-icon">Routing<wbr>Context</a></li>
								<li class="tsd-kind-class"><a href="classes/session.html" class="tsd-kind-icon">Session</a></li>
								<li class="tsd-kind-class"><a href="classes/sessionhandler.html" class="tsd-kind-icon">Session<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/sessionstore.html" class="tsd-kind-icon">Session<wbr>Store</a></li>
								<li class="tsd-kind-class"><a href="classes/sockjshandler.html" class="tsd-kind-icon">SockJSHandler</a></li>
								<li class="tsd-kind-class"><a href="classes/sockjshandleroptions.html" class="tsd-kind-icon">SockJSHandler<wbr>Options</a></li>
								<li class="tsd-kind-class"><a href="classes/sockjssocket.html" class="tsd-kind-icon">SockJSSocket</a></li>
								<li class="tsd-kind-class"><a href="classes/statichandler.html" class="tsd-kind-icon">Static<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/templateengine.html" class="tsd-kind-icon">Template<wbr>Engine</a></li>
								<li class="tsd-kind-class"><a href="classes/templatehandler.html" class="tsd-kind-icon">Template<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/timeouthandler.html" class="tsd-kind-icon">Timeout<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/usersessionhandler.html" class="tsd-kind-icon">User<wbr>Session<wbr>Handler</a></li>
								<li class="tsd-kind-class"><a href="classes/virtualhosthandler.html" class="tsd-kind-icon">Virtual<wbr>Host<wbr>Handler</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Interfaces</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-interface"><a href="interfaces/authhandler.html" class="tsd-kind-icon">Auth<wbr>Handler</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals current ">
						<a href="globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-enum">
						<a href="enums/loggerformat.html" class="tsd-kind-icon">Logger<wbr>Format</a>
					</li>
					<li class=" tsd-kind-enum">
						<a href="enums/transport.html" class="tsd-kind-icon">Transport</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/basicauthhandler.html" class="tsd-kind-icon">Basic<wbr>Auth<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/bodyhandler.html" class="tsd-kind-icon">Body<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/bridgeevent.html" class="tsd-kind-icon">Bridge<wbr>Event</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/bridgeoptions.html" class="tsd-kind-icon">Bridge<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/csrfhandler.html" class="tsd-kind-icon">CSRFHandler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/chainauthhandler.html" class="tsd-kind-icon">Chain<wbr>Auth<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/clusteredsessionstore.html" class="tsd-kind-icon">Clustered<wbr>Session<wbr>Store</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/cookie.html" class="tsd-kind-icon">Cookie</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/cookiehandler.html" class="tsd-kind-icon">Cookie<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/corshandler.html" class="tsd-kind-icon">Cors<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/digestauthhandler.html" class="tsd-kind-icon">Digest<wbr>Auth<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/errorhandler.html" class="tsd-kind-icon">Error<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/faviconhandler.html" class="tsd-kind-icon">Favicon<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/fileupload.html" class="tsd-kind-icon">File<wbr>Upload</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/formloginhandler.html" class="tsd-kind-icon">Form<wbr>Login<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/http2pushmapping.html" class="tsd-kind-icon">Http2<wbr>Push<wbr>Mapping</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/jwtauthhandler.html" class="tsd-kind-icon">JWTAuth<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/languageheader.html" class="tsd-kind-icon">Language<wbr>Header</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/localsessionstore.html" class="tsd-kind-icon">Local<wbr>Session<wbr>Store</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/locale.html" class="tsd-kind-icon">Locale</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/loggerhandler.html" class="tsd-kind-icon">Logger<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/mimeheader.html" class="tsd-kind-icon">MIMEHeader</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/oauth2authhandler.html" class="tsd-kind-icon">OAuth2<wbr>Auth<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/parsedheadervalue.html" class="tsd-kind-icon">Parsed<wbr>Header<wbr>Value</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/parsedheadervalues.html" class="tsd-kind-icon">Parsed<wbr>Header<wbr>Values</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/permittedoptions.html" class="tsd-kind-icon">Permitted<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/redirectauthhandler.html" class="tsd-kind-icon">Redirect<wbr>Auth<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/responsecontenttypehandler.html" class="tsd-kind-icon">Response<wbr>Content<wbr>Type<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/responsetimehandler.html" class="tsd-kind-icon">Response<wbr>Time<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/route.html" class="tsd-kind-icon">Route</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/router.html" class="tsd-kind-icon">Router</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/routingcontext.html" class="tsd-kind-icon">Routing<wbr>Context</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/session.html" class="tsd-kind-icon">Session</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/sessionhandler.html" class="tsd-kind-icon">Session<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/sessionstore.html" class="tsd-kind-icon">Session<wbr>Store</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/sockjshandler.html" class="tsd-kind-icon">SockJSHandler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/sockjshandleroptions.html" class="tsd-kind-icon">SockJSHandler<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/sockjssocket.html" class="tsd-kind-icon">SockJSSocket</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/statichandler.html" class="tsd-kind-icon">Static<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/templateengine.html" class="tsd-kind-icon">Template<wbr>Engine</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/templatehandler.html" class="tsd-kind-icon">Template<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/timeouthandler.html" class="tsd-kind-icon">Timeout<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/usersessionhandler.html" class="tsd-kind-icon">User<wbr>Session<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/virtualhosthandler.html" class="tsd-kind-icon">Virtual<wbr>Host<wbr>Handler</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/authhandler.html" class="tsd-kind-icon">Auth<wbr>Handler</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>